home *** CD-ROM | disk | FTP | other *** search
/ BCI NET 2 / BCI NET 2.iso / archives / programming / c / c2man-2.0pl33.lha / c2man-2.0 / INSTALL < prev    next >
Encoding:
Text File  |  1995-01-24  |  3.5 KB  |  75 lines
  1. INSTALLING c2man:
  2.  
  3. 1. For OS/2 and MSDOS, see the README.pc file in the pc directory.
  4.  
  5.    For all flavours of Unix, run Configure and answer the questions.
  6.    Most of the time the default answers should do the trick, but here's some
  7.    tips; If you're using...
  8.  
  9. ANSI-C:    Don't put the compiler in strict ISO/ANSI mode, since c2man uses a few
  10.     UNIX-isms that may disappear from your header files if you do that
  11.     (eg: popen). Don't use -ansi on gcc for example.
  12.  
  13. gcc:    Do yourself a favour and use the latest version of gcc (>= 2.3.3).
  14.     If you use -Wall, also use -Wno-implicit if your system header files
  15.     don't declare basic stuff like fprintf in stdio.h (SunOS Release 4.1.2
  16.     for example!).
  17.  
  18. bison:    If you get link errors reporting `alloca' as undefined, try specifying
  19.     -lPW when Configure asks `Any additional libraries?'.
  20.  
  21. flex:    You may need to specify -lfl when asked `Any additional libraries?'.
  22.     Flex versions 2.3 and older will cause c2man to hang if it encounters
  23.     an 8 bit character in the input file.  If you require 8-bit character
  24.     support, use the flex flag '-8' (this is the default for flex 2.4).
  25.  
  26. Sun:    Sun yacc outputs old prototypes for malloc and free (says they return
  27.     char * instead of void *), which conflict with the correct ones flex 2.3
  28.     generates if you use gcc. To make matters worse, gcc 2.2 errors on the
  29.     old prototypes even if you don't use flex. Use bison instead, or just
  30.     delete the incorrect prototypes on the first line of y.tab.c when the
  31.     make errors. If you use gcc 2.2, just upgrade your gcc.
  32.  
  33. HPUX:    When using cc, don't specify -Aa.  Adding -D_HPUX_SOURCE may help too.
  34.     If you use the optional c89 compiler instead of standard cc, specify
  35.     -D_INCLUDE_POSIX_SOURCE -D_INCLUDE_XOPEN_SOURCE as your compiler flags.
  36.  
  37. dbmalloc:
  38.     Specify a compiler flag of -DDBMALLOC (and optimization -g if you like)
  39.     and a library of -ldbmalloc for maximum checking. Don't use dbmalloc
  40.     with gcc and flex, or y.tab.c will fail to build; just use lex instead.
  41.     Don't use the shared version of your C library (eg: -lc_s), as
  42.     Configure will by default, lest you get multiply defined symbols.
  43.  
  44. Interactive Unix 2.2:
  45.     If you use gcc (which requires -posix) ignore the warnings about
  46.     popen/pclose not being defined - apparently they aren't in POSIX.
  47.  
  48. NeXT:    In NeXTstep 3.1 and greater, `cc -C -E' is broken; tell Configure to
  49.     run the preprocessor as `/lib/cpp -C' or `cc -C -E -traditional-cpp'.
  50.     On NeXTstep 3.2, don't link with -lposix.  It's busted.  Sigh.
  51.  
  52. Otherwise, If you get any errors or warnings, please report them to me (with
  53. fixes if possible!). Don't worry too much about warnings from y.tab.c or
  54. lex.yy.c though, since they're generally at the mercy of your yacc & lex.
  55.  
  56. 2. run make depend, if you didn't do it at the end of Configure.
  57.  
  58. 3. run make
  59.  
  60. 4. format (and read) the manual page in c2man.1.
  61.    The examples in it are automatically generated, so check that it looks OK.
  62.  
  63. 5. Optionally, run "make test > /dev/null" if you don't want to wade though
  64.    heaps of output, or "make test | nroff -man | more" if you do. This runs
  65.    c2man over the examples, and on its own source. The test is assumed to pass
  66.    if it doesn't error or dump core.
  67.  
  68.    If the preprocessor you told Configure that c2man is to use is different to
  69.    the one used to when compiling c2man itself, the test may fail because the
  70.    definitions in config.h may not match the preprocessor c2man will run
  71.    during the test and in normal use.
  72.  
  73. 6. As root, do "make install". This will install the c2man binary, the example
  74.    files and the manual page.
  75.